Platform Explorer / Nuxeo Platform 2021.62

Operation Retention.FireEvent (Fire Retention Event)

Description

Fire a retention business related event. The record needs to be attached to a event based retention rule
Operation id Retention.FireEvent
Category Retention
Label Fire Retention Event
Requires
Since

Parameters

Name Description Type Required Default value
name string yes  
audit boolean no  

Signature

Inputs void
Outputs void

Implementation Information

Implementation Class Class: org.nuxeo.retention.operations.FireRetentionEvent
Contributing Component org.nuxeo.retention.operations

JSON Definition

{
  "id" : "Retention.FireEvent",
  "label" : "Fire Retention Event",
  "category" : "Retention",
  "requires" : null,
  "description" : "Fire a retention business related event. The record needs to be attached to a event based retention rule",
  "url" : "Retention.FireEvent",
  "signature" : [ "void", "void" ],
  "params" : [ {
    "name" : "name",
    "description" : null,
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "audit",
    "description" : null,
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  } ]
}